home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1302.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.7 KB  |  149 lines
  1. 63
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. WinHelp 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baWinHelp displays a windows Help file.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baWinHelp(Cmd, HelpFile, Data )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String, String, String. 
  36. --- RECORDSEPARATOR ---
  37. Cmd is the help file command. Can be one of the following: 
  38. --- RECORDSEPARATOR ---
  39. "Contents" 
  40. --- RECORDSEPARATOR ---
  41. shows the Contents page. 
  42. --- RECORDSEPARATOR ---
  43. "Context" 
  44. --- RECORDSEPARATOR ---
  45. shows the page with the "Data" context number. 
  46. --- RECORDSEPARATOR ---
  47. "PopUp" 
  48. --- RECORDSEPARATOR ---
  49. shows the page with the "Data" context number in a pop-up window. 
  50. --- RECORDSEPARATOR ---
  51. "Show" 
  52. --- RECORDSEPARATOR ---
  53. show
  54. --- RECORDSEPARATOR ---
  55. s the topic found that matches "Data" if there is one exact match. If there 
  56. --- RECORDSEPARATOR ---
  57. is more than one match, then the Search dialog box is displayed. If there is 
  58. --- RECORDSEPARATOR ---
  59. no exact match, then an error message will appear. 
  60. --- RECORDSEPARATOR ---
  61. "Search" 
  62. --- RECORDSEPARATOR ---
  63. shows the topic found that matches "Data" if there is one exact match. If there 
  64. --- RECORDSEPARATOR ---
  65. is more than one match, then the Search dialog box is displayed. If there is 
  66. --- RECORDSEPARATOR ---
  67. no match, then the Search dialog box appears. 
  68. --- RECORDSEPARATOR ---
  69. "Quit" 
  70. --- RECORDSEPARATOR ---
  71. closes the Help file. 
  72. --- RECORDSEPARATOR ---
  73. "Help" 
  74. --- RECORDSEPARATOR ---
  75. shows the Help-On-Help page. 
  76. --- RECORDSEPARATOR ---
  77. "Macro" 
  78. --- RECORDSEPARATOR ---
  79. executes the Help m
  80. --- RECORDSEPARATOR ---
  81. acro named in "Data". 
  82. --- RECORDSEPARATOR ---
  83. HelpFile is the name of the Help file to display. This should include the complete 
  84. --- RECORDSEPARATOR ---
  85. path to the help file. 
  86. --- RECORDSEPARATOR ---
  87. Data is a string containing extra information. This will vary according to the Cmd 
  88. --- RECORDSEPARATOR ---
  89. used. Note that even if a number is required, this must be passed as a string. 
  90. --- RECORDSEPARATOR ---
  91. "Contents" 
  92. --- RECORDSEPARATOR ---
  93. Data should be "". 
  94. --- RECORDSEPARATOR ---
  95. "Context" 
  96. --- RECORDSEPARATOR ---
  97. Data is the context number, eg "4". 
  98. --- RECORDSEPARATOR ---
  99. "PopUp" 
  100. --- RECORDSEPARATOR ---
  101. Data is the context number, eg "4". 
  102. --- RECORDSEPARATOR ---
  103. "Show" 
  104. --- RECORDSEPARATOR ---
  105. Data is the topic string to show, eg "About BudAPI". 
  106. --- RECORDSEPARATOR ---
  107. "Search" 
  108. --- RECORDSEPARATOR ---
  109. Data is the topic string to search for, eg "About BudAPI". 
  110. --- RECORDSEPARATOR ---
  111. "Quit" 
  112. --- RECORDSEPARATOR ---
  113. Data should be "". 
  114. --- RECORDSEPARATOR ---
  115. "Help" 
  116. --- RECORDSEPARATOR ---
  117. Data should be "". 
  118. --- RECORDSEPARATOR ---
  119. "Macro" 
  120. --- RECORDSEPARATOR ---
  121. Data should be the name of the macro to execute, eg "PlayMovie".
  122. --- RECORDSEPARATOR ---
  123.  
  124. --- RECORDSEPARATOR ---
  125. Returns:
  126. --- RECORDSEPARATOR ---
  127.  
  128. --- RECORDSEPARATOR ---
  129. Integer. 
  130. --- RECORDSEPARATOR ---
  131. Returns 1 if successful, else 0. Not finding the Help file is not considered a failure.
  132. --- RECORDSEPARATOR ---
  133.  
  134. --- RECORDSEPARATOR ---
  135. Examples:
  136. --- RECORDSEPARATOR ---
  137.  
  138. --- RECORDSEPARATOR ---
  139. Director: 
  140. --- RECORDSEPARATOR ---
  141. set OK = WinHelp( "Show", the pathName & "myhelp.hlp", "Flowers" ) 
  142. --- RECORDSEPARATOR ---
  143. set OK = WinHelp( "Quit", the pathName & "myhelp.hlp", "" ) 
  144. --- RECORDSEPARATOR ---
  145. Authorware: 
  146. --- RECORDSEPARATOR ---
  147. OK := WinHelp( "Show", FileLocation ^ "myhelp.hlp", "Flowers" ) 
  148. --- RECORDSEPARATOR ---
  149. OK := WinHelp( "Quit", FileLocation ^ "myhelp.hlp", "" )